home *** CD-ROM | disk | FTP | other *** search
/ PC World Interactive 7 / PC World Interactive 7.iso / pcgames / EMERGY / BC5 / EXAMPLES / OWL / CLASSES / HOTKEY / readme.txt
Text File  |  1997-03-25  |  2KB  |  72 lines
  1. Copyright Borland International
  2. ObjectWindows (C) 1995
  3.  
  4. Title: HOTKEY Example
  5.  
  6. Keywords: THotKey;Common Control
  7.  
  8. THotKey, an Introduction
  9. ========================
  10. The ObjectWindows THotKey class encapsulates the hot-key control
  11. from the Common Control Library. The control allows the user to
  12. enter a combination keystrokes to be used as a hot key. (A hot
  13. key is a key combination that the user can press to perform an
  14. action quickly. The key combination can consist of a modifier
  15. key, such as CTRL, ALT or SHIFT, and an accomapanying key, such
  16. as a character key, an arrow key or a function key).
  17.  
  18.  
  19. Creating a THotKey Object
  20. =========================
  21. THotKey offers two constructors: one for creating a hot-key
  22. control from scratch and one for aliasing a hot-key control
  23. which was defined in a dialog resource. 
  24.  
  25. The following code snippet illustrates how to create a brand new
  26. hot-key control within a window represented by the class
  27. TMyWindow.
  28.  
  29.    TMyWindow::TMyWindow(TWindow* parent) : TWindow(parent)
  30.    {
  31.       HotKey = new THotKey(this, ID_HOTKEY, 10, 10, 40, 40);
  32.    }
  33.  
  34. NOTE: Since the control is newed within the constructor of it's
  35. parent object, you need not explictly invoke its 'Create'
  36. method. ObjectWindows' autocreate feature will ensure that the
  37. control is created after the creation of the parent window.
  38.  
  39. To alias a hot-key control from a dialog resource, you must use
  40. the other constructor of the THotKey class. The following code
  41. fragment illustrates:
  42.  
  43.    TMyDialog::TMyDialog(TWindow* parent, TResId resId)
  44.              :TDialog(parent, resId)
  45.    {
  46.       HotKey = new THotKey(this, IDC_HOTKEY);
  47.    }
  48.              
  49.  
  50. Setting and Retrieving the Key Combination
  51. ==========================================
  52. The 'SetHotKey' and 'GetHotKey' methods of THotKey allow you to
  53. set and retrieve the virtual key code and modifier flags of a
  54. hot-key from a hot-key control.
  55.  
  56.  
  57. Using a hot-key
  58. ===============
  59. The value returned from the 'GetHotKey' method can be used with
  60. the WM_SETHOTKEY message to associate a window with a hot-key.
  61. When user presses the hot-key, the system activates the window.
  62.  
  63.  
  64. Additional Information
  65. ======================
  66. 1. The value retrieved from the hot-key control is not usable
  67. with the 'RegisterHotKey' API.
  68. 2. You can customize a hot-key control by specifying invalid key
  69. combinations and providing the default modifier. See the 'SetRules'
  70. method for more information.
  71.  
  72.